<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template map_index</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.map__index_8hpp" title="Header &lt;boost/interprocess/indexes/map_index.hpp&gt;">
<link rel="prev" href="classboost_1_1interprocess_1_1iunordered__set__index.html" title="Class template iunordered_set_index">
<link rel="next" href="classboost_1_1interprocess_1_1null__index.html" title="Class template null_index">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1interprocess_1_1iunordered__set__index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.map__index_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1interprocess_1_1null__index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template map_index</span></h2>
<p>boost::interprocess::map_index</p>
</div>
<h2 class="refsynopsisdiv-title">Synopsis</h2>
<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.map__index_8hpp" title="Header &lt;boost/interprocess/indexes/map_index.hpp&gt;">boost/interprocess/indexes/map_index.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MapConfig<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="classboost_1_1interprocess_1_1map__index.html" title="Class template map_index">map_index</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">iterator</span>         <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a4ef9a4e51d565209db738090692d97d0"></a><span class="identifier">iterator</span><span class="special">;</span>          
  <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">const_iterator</span>   <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1aec19d9b99fab9d24192a4760aadfb2e4"></a><span class="identifier">const_iterator</span><span class="special">;</span>    
  <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">value_type</span>       <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a6bad62009e57775796da69d3352d0d44"></a><span class="identifier">value_type</span><span class="special">;</span>        
  <span class="keyword">typedef</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">compare_key_type</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1abef08a014280a98fd3300fe6cea30538"></a><span class="identifier">compare_key_type</span><span class="special">;</span>  
  <span class="keyword">typedef</span> <span class="identifier">iterator</span>                    <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a52dbbba404b2ca06dcc749c2fa27bf1f"></a><span class="identifier">insert_commit_data</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">iterator</span>                    <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1abc496846d692e4e413d3f881a9a7b356"></a><span class="identifier">index_data_t</span><span class="special">;</span>      

  <span class="comment">// <a class="link" href="../boost_container_header_reference/classboost_1_1container_1_1flat__multimap.html#id29-bb">public member functions</a></span>
  <a class="link" href="classboost_1_1interprocess_1_1map__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a4679eff3401de4bb48b90fe9c042f233"><span class="identifier">map_index</span></a><span class="special">(</span><a class="link" href="classboost_1_1interprocess_1_1segment__manager__base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1interprocess_1_1map__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a670b4d44be84b764d17827f16b720b13"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1interprocess_1_1map__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a5194793b20e962cca0b77797506d682f"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&gt;</span> 
  <a class="link" href="classboost_1_1interprocess_1_1map__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a7927d0771ce2833eb67dae4416d1a95f"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="classboost_1_1interprocess_1_1map__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a02e155e77cc7353efc47560b54dc5b69"><span class="identifier">insert_commit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">index_data_t</span> <span class="special">&amp;</span><span class="special">,</span> 
                         <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="classboost_1_1interprocess_1_1map__index.html#doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1ae7d199fc28ff94f79ab8fa623189c1f6"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.16.19.3.30.4.4"></a><h2>Description</h2>
<p>Index type based in boost::interprocess::map. Just derives from boost::interprocess::map and defines the interface needed by managed memory segments </p>
<div class="refsect2">
<a name="id-1.3.16.19.3.30.4.4.3"></a><h3>
<a name="id29-bb"></a><code class="computeroutput">map_index</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a4679eff3401de4bb48b90fe9c042f233"></a><span class="identifier">map_index</span><span class="special">(</span><a class="link" href="classboost_1_1interprocess_1_1segment__manager__base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre>
<p>Constructor. Takes a pointer to the segment manager. Can throw </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a670b4d44be84b764d17827f16b720b13"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre>
<p>This reserves memory to optimize the insertion of n elements in the index </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a5194793b20e962cca0b77797506d682f"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>This tries to free previously allocate unused memory. </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&gt;</span> 
<a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a7927d0771ce2833eb67dae4416d1a95f"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span> key<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1a02e155e77cc7353efc47560b54dc5b69"></a><span class="identifier">insert_commit</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span> k<span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> context<span class="special">,</span> 
                       <span class="identifier">index_data_t</span> <span class="special">&amp;</span> index_data<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="doxygen.boost_interprocess_header_reference.classboost_1_1interprocess_1_1map__index_1ae7d199fc28ff94f79ab8fa623189c1f6"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">compare_key_type</span> <span class="special">&amp;</span> k<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</div>
<div class="copyright-footer">Copyright © 2005-2024 Ion Gaztanaga<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1interprocess_1_1iunordered__set__index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#doxygen.boost_interprocess_header_reference.map__index_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1interprocess_1_1null__index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
